cmd/setec: be more deliberate about whitespace in text values #108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously we added the --verbatim flag to override the default removal of whitespace from plaintext secret values. I have now repeatedly tripped over forgetting this default on PEM-formatted key values, so I propose we make it harder to commit that error. This change refines the check: If a value is not UTF-8, or does not have leading or trailing whitespace, it is processed verbatim as before. Now, however, if a UTF-8 value has leading or trailing whitespace, the user must explicitly say what to do: Either set --verbatim to keep it, or set the new --trim-space flag to remove it. Failing to set either flag reports an error so the user does not get surprised.
fylie
approved these changes
May 1, 2024
soniaappasamy
approved these changes
May 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously we added the --verbatim flag to override the default removal of
whitespace from plaintext secret values. I have now repeatedly tripped over
forgetting this default on PEM-formatted key values, so I propose we make it
harder to commit that error.
This change refines the check: If a value is not UTF-8, or does not have
leading or trailing whitespace, it is processed verbatim as before.
Now, however, if a UTF-8 value has leading or trailing whitespace, the user
must explicitly say what to do: Either set --verbatim to keep it, or set the
new --trim-space flag to remove it. Failing to set either flag reports an error
so the user does not get surprised.